<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left{
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: left }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">


<div class="section" id="intro">
<h1>INTRO</h1>
<p>Marave is a text editor whose goal is to help you focus on writing.</p>
<p>It's inspired by ommwriter, Darkroom and many other &quot;simple&quot; text
editors, with a few twists.</p>
</div>
<div class="section" id="requirements">
<h1>REQUIREMENTS</h1>
<p>As far as I know, all that's needed is:</p>
<ul class="simple">
<li>PyQt 4.5 or later.
On Ubuntu and other linuxes, this may mean python-qt4-phonon or some other
packages in addition to PyQt.</li>
<li>PyEnchant if you want spellchecking, plus the spellchecking dictionaries for your language.</li>
<li>I intend to make binaries available for Windows, and am looking for volunteers
help to have Mac binaries as well.</li>
</ul>
</div>
<div class="section" id="menu">
<h1>MENU</h1>
<p>If you move your button, you will see a button bar at the right side of the screen.</p>
<p>They are:</p>
<ul>
<li><p class="first">Your font selector</p>
<p>You can set the font and color of your text.</p>
</li>
<li><p class="first">Your font size selector</p>
<p>You can make it larger, smaller, or go back to default.</p>
</li>
<li><p class="first">The usual file operations</p>
<p>Open, Save and Save As. For &quot;New File&quot;, use Ctrl+N</p>
</li>
<li><p class="first">A background selector</p>
<p>Cycle the available backgrounds using the arrows, or use a solid colour.</p>
</li>
<li><p class="first">A keyclick selector</p>
<p>Cycle the available key sounds, or disable key clicks.</p>
</li>
<li><p class="first">A &quot;music station&quot; selector</p>
<p>Cycle available music stations, or disable music.</p>
</li>
<li><p class="first">Extra preferences</p>
<p>Several options, including editor opacity, spell-checking language and more.</p>
</li>
<li><p class="first">Quit</p>
</li>
</ul>
</div>
<div class="section" id="cheatcodes">
<h1>CHEATCODES</h1>
<p>Since the UI is minimal, there are some key combinations that do things you will not
find any buttons for.</p>
<ul class="simple">
<li>Undo: Ctrl+Z</li>
<li>Redo: Strift+Ctrl+Z</li>
<li>New Document: Ctrl+N</li>
<li>Open: Ctrl+O</li>
<li>Save: Ctrl+S</li>
<li>Save As: Shift+Ctrl+S</li>
<li>Find: Ctrl+F</li>
<li>Find &amp; Replace: Ctrl+R</li>
<li>Quit: Ctrl+Q</li>
<li>Document information: Ctrl+I</li>
</ul>
</div>
<div class="section" id="adjusting-the-editor">
<h1>Adjusting the editor</h1>
<p>The Marave window is <em>always</em> full screen, you can't change that, but you can change th size of your editor.</p>
<p>If you move your mouse, you will see 4 faint boxes in the corners. Dragging them makes the editor larger or smaller.</p>
<p>If you place the mouse just outside the editor, it should change its shape to a hand. Clicking and dragging will let you move the editor. Remember that the buttons are on the right side, so you need some space there.</p>
</div>
<div class="section" id="customization">
<h1>CUSTOMIZATION</h1>
<p>If you don't like the artwork that comes with Marave, you are of course free to replace it, or expand it.</p>
<ul class="simple">
<li>You can add new key click sounds by dropping audio files in the clicks folder</li>
<li>You can add new backgrounds by dropping image files in the backgrounds folder</li>
<li>You can add new radio stations by adding them in the radios.txt file (one
per line)</li>
</ul>
</div>
<div class="section" id="themes-and-styles">
<h1>THEMES and STYLES</h1>
<p>You can save your settings as a &quot;theme&quot;, or choose your theme from the provided presets.</p>
<p>A theme contains:</p>
<ul class="simple">
<li>Background</li>
<li>Font and font size</li>
<li>Editor size and position</li>
<li>Editor opacity</li>
<li>Style</li>
<li>Music and click sound</li>
<li>Button style (icon only/text+icon/text only)</li>
</ul>
<p>Themes are saved in the themes folder, the syntax is INI-like.</p>
<p>A style is a file with a syntax similar to CSS, and it lets you change the look of all UI elements
in Marave. These files are saved in the stylesheets folder, and you can select them from the
preferences panel.</p>
<p>Note: Style changes only take effect after you restart Marave.</p>
</div>
<div class="section" id="installation">
<h1>INSTALLATION</h1>
<p>To install from sources try this:</p>
<pre class="literal-block">
python setup.py install
</pre>
<p>To use Marave without installing, run</p>
<pre class="literal-block">
python marave-editor
</pre>
<p>Or, on Linux, make it executable and run it directly:</p>
<pre class="literal-block">
chmod +x marave-editor
./marave-editor
</pre>
<div class="sidebar">
<p class="first sidebar-title">Syntax Highlighting</p>
<p>The syntax highlighting support is experimental and a bit hard to enable.</p>
<p>You need to install the following:</p>
<ul class="simple">
<li>GNU source-highlight, from <a class="reference external" href="http://www.gnu.org/software/src-highlite/">http://www.gnu.org/software/src-highlite/</a></li>
<li>Source-highlight-qt, from <a class="reference external" href="http://srchiliteqt.sourceforge.net/">http://srchiliteqt.sourceforge.net/</a></li>
<li>SIP, which should come with PyQt</li>
<li>A C++ compiler</li>
</ul>
<p>Then, run</p>
<pre class="literal-block">
python setup.py build_hl
python setup.py install
</pre>
<p class="last">If all goes well (unlikely ;-), it should work. If it doesn't marave will work anyway, just without
syntax highlighting.</p>
</div>
</div>
<div class="section" id="credits">
<h1>CREDITS</h1>
<div class="section" id="code">
<h2>CODE</h2>
<p>Spell checker support thanks to John Nachtimwald
<a class="reference external" href="http://john.nachtimwald.com/2009/08/22/qplaintextedit-with-in-line-spell-check/">http://john.nachtimwald.com/2009/08/22/qplaintextedit-with-in-line-spell-check/</a></p>
<p>Several patches by Filipe Maia</p>
<p>Plugin system inspired by Armin Ronacher's code at
<a class="reference external" href="http://lucumr.pocoo.org/2006/7/3/python-plugin-system">http://lucumr.pocoo.org/2006/7/3/python-plugin-system</a></p>
<p>Smartypants plugin based on smartypants.py by John Gruber and Chad Miller,
<a class="reference external" href="http://web.chad.org/projects/smartypants.py/">http://web.chad.org/projects/smartypants.py/</a> ( See the <a class="reference external" href="smartypants_license.html">license</a>)</p>
<p>The rest is written by me: Roberto Alsina &lt;<a class="reference external" href="mailto:ralsina&#64;netmanagers.com.ar">ralsina&#64;netmanagers.com.ar</a>&gt;</p>
</div>
<div class="section" id="translations">
<h2>TRANSLATIONS</h2>
<p>The hebrew translation was created by Yaron Shahrabani
The german translation was created by Marc Cheng
The polish translation was created by Łukasz &quot;Cyber Killer&quot; Korpalski
The czech translation was created by  Martin Stiborský
The italian translation was created by Pierpaolo da Fieno</p>
</div>
<div class="section" id="icons">
<h2>ICONS</h2>
<p>The icons are taken from the Reinhardt SVG icon set, or based on them:
<a class="reference external" href="http://www.kde-look.org/content/show.php/The+Reinhardt+Icon+Set?content=6153">http://www.kde-look.org/content/show.php/The+Reinhardt+Icon+Set?content=6153</a></p>
<p>The Marave icon is by Pierpaolo Da Fieno</p>
</div>
<div class="section" id="images">
<h2>IMAGES</h2>
<dl class="docutils">
<dt>&quot;Winter landscape classic&quot; by saturn_h</dt>
<dd><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">license:</th><td class="field-body"><a class="reference external" href="http://creativecommons.org/licenses/by-nc-sa/2.0/deed.en">http://creativecommons.org/licenses/by-nc-sa/2.0/deed.en</a></td>
</tr>
<tr class="field"><th class="field-name">URL:</th><td class="field-body"><a class="reference external" href="http://www.flickr.com/photos/hhoyer/3219911918/">http://www.flickr.com/photos/hhoyer/3219911918/</a></td>
</tr>
</tbody>
</table>
</dd>
<dt>&quot;Dutch winter landscape&quot; by zoutedrop</dt>
<dd><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">license:</th><td class="field-body"><a class="reference external" href="http://creativecommons.org/licenses/by/2.0/deed.en">http://creativecommons.org/licenses/by/2.0/deed.en</a></td>
</tr>
<tr class="field"><th class="field-name">URL:</th><td class="field-body"><a class="reference external" href="http://www.flickr.com/photos/zoutedrop/3055849607/">http://www.flickr.com/photos/zoutedrop/3055849607/</a></td>
</tr>
</tbody>
</table>
</dd>
<dt>&quot;Landscape with sky&quot; by randihausken</dt>
<dd><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">license:</th><td class="field-body"><a class="reference external" href="http://creativecommons.org/licenses/by-nc/2.0/deed.en">http://creativecommons.org/licenses/by-nc/2.0/deed.en</a></td>
</tr>
<tr class="field"><th class="field-name">URL:</th><td class="field-body"><a class="reference external" href="http://www.flickr.com/photos/randihausken/2212472428/">http://www.flickr.com/photos/randihausken/2212472428/</a></td>
</tr>
</tbody>
</table>
</dd>
<dt>&quot;Just green curls&quot; by cjcox</dt>
<dd><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">license:</th><td class="field-body">GPL</td>
</tr>
<tr class="field"><th class="field-name">URL:</th><td class="field-body"><a class="reference external" href="http://www.kde-look.org/content/show.php/Just+Green+Curls?content=118222&amp;PHPSESSID=299f3350a78b1ad0ca3c576436a2ac47">http://www.kde-look.org/content/show.php/Just+Green+Curls?content=118222&amp;PHPSESSID=299f3350a78b1ad0ca3c576436a2ac47</a></td>
</tr>
</tbody>
</table>
</dd>
</dl>
</div>
<div class="section" id="sound">
<h2>SOUND</h2>
<p>The music is streamed from:</p>
<ul class="simple">
<li>BlueMars radio: <a class="reference external" href="http://bluemars.org/">http://bluemars.org/</a></li>
<li>SomaFM: <a class="reference external" href="http://somafm.com/">http://somafm.com/</a></li>
</ul>
<p>All click sounds are downloaded from
<a class="reference external" href="http://www.adobeflash.com/download/sounds/clicks/">http://www.adobeflash.com/download/sounds/clicks/</a></p>
<p>thozi_daCLick.mp3 had no credit information</p>
<p>The following sounds are created by the people at
<a class="reference external" href="http://www.adriantnt.com">http://www.adriantnt.com</a> and this link fulfills
their license requirements:</p>
<ul class="simple">
<li>adriantnt_r_plastic.mp3</li>
<li>adriantnt_u_click.mp3</li>
</ul>
<p>The following sounds are created by Partners In Rhyme and
included with permission:</p>
<ul class="simple">
<li>BEEP1A.WAV</li>
<li>BEEP1B.WAV</li>
<li>BEEP1C.WAV</li>
<li>CLICK10A.WAV</li>
<li>SERVO1A.WAV</li>
</ul>
<p>You can find more click sounds at <a class="reference external" href="http://www.partnersinrhyme.com/pirsounds/WEB_DESIGN_SOUNDS_WAV/BUTTONS.shtml">http://www.partnersinrhyme.com/pirsounds/WEB_DESIGN_SOUNDS_WAV/BUTTONS.shtml</a></p>
</div>
</div>
</div>
</body>
</html>
